<?
/**
 * This file is part of XNAT light.
 *
 * XNAT light is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * XNAT light is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with XNAT light.  If not, see <http://www.gnu.org/licenses/>.
 */
namespace NRG\Xnat;

use NRG\Exceptions as Exceptions;
use NRG\Database\Mappers as Mappers;

/**
 * XNAT MR scan model
 *
 * @package NRG\Xnat
 */
class Scan extends XObject
{
    /**
     * Scan number
     *
     * @var int
     */
    protected $_number;

    /**
     * Scan type
     *
     * @var string
     */
    protected $_type;
    
    /**
     * Scan sequence description
     *
     * @var string
     */
    protected $_description;

    /**
     * Scan quality
     *
     * @var string
     */
    protected $_quality;
    
    /**
     * Scanner manufacturer
     *
     * @var string
     */
    protected $_manufacturer;

    /**
     * Scanner model
     *
     * @var string
     */
    protected $_model;
    
    /**
     * Scanner bay
     *
     * @var string
     */
    protected $_bay;

    /**
     * Scan note
     *
     * @var string
     */
    protected $_note;
    
    /**
     * Scanner operator
     *
     * @var string
     */
    protected $_operator;

    /**
     * Constructor
     */
    public function __construct()
    {
	parent::__construct();
    }

    /**
     * Set the scan type e.g. 'BOLD'
     * 
     * @param string $type
     */
    public function setType($type=null)
    {
	$this->_type = $type;
    }

    /**
     * Access the scan type
     * 
     * @return string
     */
    public function getType()
    {
	return $this->_type;
    }

    /**
     * Set scan series description e.g. 'fMRI_resting_state'
     *
     * @param string $description
     */
    public function setSeriesDescription($description=null)
    {
	$this->_description = $description;
    }

    /**
     * Access scan series description
     * 
     * @return string
     */
    public function getSeriesDescription()
    {
	return $this->_description;
    }

    /**
     * Set scan quality e.g. 'usable'
     * 
     * @param string $quality
     */
    public function setQuality($quality=null)
    {
	$this->_quality = $quality;
    }

    /**
     * Access scan quality
     *
     * @return string
     */
    public function getQuality()
    {
	return $this->_quality;
    }

    /**
     * Set the scanner manufacturer 
     * 
     * @param string $scanner
     */
    public function setManufacturer($manufacturer=null)
    {
	$this->_manufacturer = $manufacturer;
    }

    /**
     * Access scanner manufacturer
     *
     * @return string
     */
    public function getManufacturer()
    {
	return $this->_manufacturer;
    }

    /**
     * Set the scanner model e.g. "TimTrio"
     *
     * @param string $model 
     */
    public function setModel($model=null)
    {
	$this->_model = $model;
    }

    /**
     * Access scanner model
     *
     * @return string
     */
    public function getModel()
    {
	return $this->_model;
    }

    /**
     * Set the scanner bay e.g. 'BAY04'
     *
     * @param string $bay
     */
    public function setBay($bay=null)
    {
	$this->_bay = $bay;
    }

    /**
     * Access the scanner bay
     *
     * @return string
     */
    public function getBay()
    {
	return $this->_bay;
    }

    /**
     * Set the scan number
     *
     * @param int $number
     */
    public function setScanNumber($number=null)
    {
	$this->_number = $number;
    }

    /**
     * Access the scan number
     *
     * @return int
     */
    public function getScanNumber()
    {
	return $this->_number;
    }

    /**
     * Set the scan note
     *
     * @param string $note
     */
    public function setNote($note=null)
    {
	$this->_note = $note;
    }

    /**
     * Access the scan note
     *
     * @return string
     */
    public function getNote()
    {
	return $this->_note;
    }

    /**
     * Set scan operator
     *
     * @param string $operator
     */
    public function setOperator($operator=null)
    {
	$this->_operator = $operator;
    }

    /**
     * Access scan operator
     *
     * @return string
     */
    public function getOperator()
    {
	return $this->_operator;
    }
}
